The CygNet FMS ActiveX controls have an additional set of properties that are listed on the ActiveX page of the Property Sheet seen in CygNet Studio/Vision screens. These properties are listed in the comprehensive properties table below, and also in Properties, Methods, and Events topics specific to each ActiveX control.
The Comprehensive table contains a comprehensive listing of all the CygNet FMS ActiveX control properties.
The Control-Specific list contains links to topics containing tables of the properties, events, and methods specific to each ActiveX control.
See also CxHmiFms in the Scripting section for additional details about scripting properties specific to each FMS control object.
ActiveX properties for CygNet FMS controls are listed in the table below.
| Property | Description | Default Value |
|---|---|---|
| (OCXProperties) | Many of the ActiveX control properties can also be set in the CygNet FMS Control Properties dialog box, which is accessed via each control's CygNet Studio property sheet. On the Property Sheet, double-click (OCXProperties) or click ... to access the CygNet FMS Control Properties dialog box. | |
| AlarmRecSourceFilter | Specifies the source filter for the alarm record Options are as follows.
|
255 - Any_Alarms |
| Appearance | Specifies whether the control will have a 3D effect or a flat appearance Options are as follows.
|
0 - Flat |
| AttributeDisplaySettingsXml | Specifies the XML string that contains the accumulated display settings for the control Use the OCX Properties dialog box (Dashboard tab > Display Properties) to define. See Configuring Dashboard Display Properties for more information. |
|
| BeginDate | Specifies the start date for the control See Selecting Date and Time for more information. |
T-7 |
| BorderStyle | Specifies the border style of the control’s boundary Options are as follows.
|
0 — None |
| ButtonText | Specifies the text on the status bar button in the Node Chooser control Allowable characters (maximum of 20) are A-Z, a-z, 0-9, . (period), #, $, &, (, ), +, -, \, /, :, <, >, =, @, [, ], ^, {, }, _ (underscore), !, ~ (tilde). Spaces are acceptable, when they are not leading or trailing. |
Set as Session Node |
| ChooserAllowMultiSelect (AllowMultiSelect) |
Specifies whether to allow multiple selection of Nodes in the control's Chooser list Options are as follows.
Use the OCX Properties dialog box (General page) to define. |
1 - Yes |
| ChooserFilterString (FilterString) |
Specifies a partial string of known Node names to populate the Filter text box in the control's Chooser Wildcard values * (multiple character) and ? (single character) are supported. Use the OCX Properties to access the Control Properties dialog box (General page) to define. |
* (multiple character wildcard) - all |
| ChooserFilterType (FilterType) |
Specifies the filter type for the filter string in the control's Chooser Options are as follows.
|
0 - Name |
| ChooserGroupSelection (GroupSelection) |
Specifies the desired Node group to display in the control's Chooser Options are populated according to configured groups of the following types.
Use the OCX Properties dialog box (General page) to define. |
Depends on the groups configured in your system |
| ChooserNodeCategorySelection (NodeCategorySelection) |
Specifies the desired Node category to display in the control's Chooser Options are a subset of the following possibilities, as applicable to the selected control. Variants are noted in parentheses.
|
Depends on control |
| ChooserNodeCategoryVisible (NodeCategoryVisible) |
Specifies whether to show the Node Category selector in the control's Chooser Options are as follows.
|
1 - Yes |
| ChooserPrimarySortColumn (PrimarySortColumn) |
Specifies the primary sort column for the columns in the control's Chooser Options are as follows.
|
2 - Name |
| ChooserSiteServiceSelection (SiteServiceSelection) |
Specifies the value of the FMS [SiteService] in the control's Chooser Use the OCX Properties dialog box (General page) to define. |
|
| ChooserSiteServiceVisible (SiteServiceVisible) |
Specifies whether to show the FMS service selector in the control's Chooser Options are as follows.
Use the OCX Properties dialog box (General page) to define. |
1 - Yes |
| CmdDefinitionXml | Specifies the XML string that contains the accumulated configuration settings for the FMS command definition for the control Use the OCX Properties dialog box (Commands page) to define. See FMS Commands for more information. |
|
| ColorAcceptability | When a ColorGrid option other than "0 - None" is selected, specifies whether to show records with a % acceptability below a specified limit, according to the selected color option Options are as follows.
|
0 - No |
| ColorAcceptabilityLimit | When ColorAcceptability value is "yes" specifies the % acceptability below which to show values according to the ColorGrid selection | 0 |
| ColorExceptions | When a ColorGrid option other than "0 - None" is selected, specifies whether or not to show records with exceptions according to the selected color option Options are as follows.
|
0 - No |
| ColorGrid | Specifies the color options for selected data display in the History Grid control Options are as follows.
See Using the History Grid Control for more information. |
0 - None |
| ColorMode | Returns/sets how colors are applied on the FMS History Graph, whether to individual Nodes or based on acceptability (data quality) level Options are as follows.
|
0 - Single Node |
| ColorXml | Specifies the XML string that contains the accumulated color settings for the control Use the OCX Properties dialog box (Colors page) to define. |
|
| ColumnsXml Columns |
Specifies the XML string that describes the columns to display in the control Use the OCXProperties dialog box (<control> tab, then Columns) to define. |
|
| ConfigRecSourceFilter | Specifies the source for Node configuration data from the drop-down menu on the control's Options pane Options are as follows.
Use the OCX Properties dialog box (Configuration page) to define. |
|
| CustomColumnsUpdateInterval | Specifies the update interval, in number of seconds, for the custom data columns, as configured in the Admin Options, if displayed in the Dashboard control See Using the Dashboard Control for more information. |
Persists as set; initial default value is 60 seconds |
| DataMode | Specifies the data mode for viewing summary data in the Dashboard control Options are as follows.
|
1 - Device_Mode |
| DataQualityColorXml | Specifies the XML string that contains the accumulated color settings for the Balance control Use the OCX Properties dialog box (Data quality color button on the Balance page) to define. |
|
| DataView | Specifies the type of data view for display in the Configuration control Options are as follows.
|
0 - Data_View_Config |
| DateFormat | Specifies the date/time format for the data displayed in the control Options are as follows.
|
0 - Device_Time |
| DateTimeDisplayMode | Specifies the date display convention for the control Options are as follows.
|
0 - Leading Time |
| DecimalPrecision | Specifies the decimal precision for data values displayed in the control Acceptable values include 0 - 10 decimal places. |
7 |
| DisplayMode | Specifies the data view to display in the Raw Data control Options are as follows.
|
25 - Metering Raw |
| EndDate | Specifies the end date for the control See Selecting Date and Time for more information. |
T |
| FilterConfigXml | Specifies the XML string that contains the accumulated filter settings for the Alarm, Configuration, Dashboard, or Exceptions control. Use the "Filter" or "Log source" field on the corresponding ActiveX control property page to configure the filter settings See the usage topic and properties list for the selected control for more information about filter selection options. |
|
| Font | Accesses the MS Font dialog box, allowing specification of the text in the control. Click ... to access the Font dialog box to make font selections including type, style, size, and script options | MS Shell Dlg |
| FontSize | Specifies the font size of the text in the History Graph control Options are as follows.
|
1 - Medium |
| GridGroupsXml | Returns/sets the XML specifying the group hierarchy that will appear on the FMS Exceptions control Another way to configure this property is to use the Control Properties dialog box (from the Property Sheet ActiveX page, click OCXProperties, then the Exceptions tab, and use the Grid groups browser) on the Exceptions page. |
|
| HeightOverride | Specifies the height, in pixels, of the Value Table in the CygNet FMS History Graph control, if the UseHeightOverride value is set to 1 - Yes. | |
| IsEditing | Returns whether or not the user is currently editing data in the editable FMS control (Alarm, Configuration, or History Grid) | |
| JobTypeFilterView | Specifies the type of jobs to display in the FMS Jobs control Type the name of a job type into the text box to define the filter view desired. Options are as follows.
Note: Job types are configured in CygNet Dispatch or in FMS Explorer via the Extended Command Options on the Job Schedule Configuration page. |
<Any> |
| MaxDataQuality | Specifies the maximum data quality percentage to return records for in the FMS History Grid control Possible values for this property are integers from 1-100. |
100 |
| MaxRecords | Specifies the maximum number of exceptions records to be returned in the control | 100 |
| MeterStationView | For a Node that is a station meter (a Gas Meter Node set to also function as a station), specifies the station meter view to be displayed in the History Grid or History Graph control Options are as follows.
|
8 - Gas_Devices_Mode |
| NodeOverride | If Use Session Node is not selected, specifies the Node name against which to run the report from the Reports control | |
| PITDateTime | Specifies the Point in Time to use for the data presented in the control Acceptable values can be in one of the following forms.
See Using the Home Menu for more information about PIT mode. See Selecting Point in Time for more information about time selection. |
T - Current |
| PrimarySortColumn | Specifies the primary sort column for the columns in the control Options are as follows.
Use the OCX Properties dialog box (General page) to define. |
2 - Name |
| ProcessVarXml | Returns/sets the XML specifying which process variables will be displayed in the FMS History Graph Another way to configure this property is to use the Control Properties dialog box (from the Property Sheet, ActiveX page, click OCXProperties, then on the Graph page use the Process Variables configuration list). CygNet FMS Control Properties dialog box (from the Property Sheet, ActiveX page, click OCXProperties to access the Control Properties, then on the Exceptions page use the Grid groups browser). |
|
| RecordOrder | Specifies the order for display of records in the Dashboard or History Grid controls Options are as follows.
|
0 - Oldest_First |
| RecordSpan | Specifies the record span to display in the FMS History Graph or FMS History Grid controls Options are as follows.
|
Depends on control |
| ReportDefinitionXml | Specifies the XML of the user-configured report definition for use by the Reports control | <XML/> |
| ReportSelection | Specifies the name of the report to run from the Reports control | |
| SessionNodeClickOption | Specifies the Session Node selection behavior to use from the Dashboard control Options are as follows.
|
1 - DoubleClick |
| ShadingBackColor | Specifies the background color for a selected cell. Use the pop-up to select a color See Configuring Color for more information. |
RGB 255.250.205 (pale yellow) |
| ShadingForeColor | Specifies the foreground color for a selected cell. Use the pop-up to select a color See Configuring Color for more information. |
RGB 0.0.0 (black) |
| ShowApprovedJobs | Specifies whether to show jobs with a status of "Approved" in the CygNet FMS Jobs control Options are as follows.
|
1 - Yes |
| ShowAutoResolved | Specifies whether to show exceptions that have resolved automatically in the CygNet FMS Exceptions control Options are as follows.
|
1 - Yes |
| ShowBlockedJobs | Specifies whether to show jobs with a status of "Blocked" in the CygNet FMS Jobs control Options are as follows.
|
1 - Yes |
| ShowChooserPane | Specifies whether to show the Chooser pane in the CygNet FMS ActiveX control Options are as follows.
|
1 - Yes |
| ShowCompletedJobs | Specifies whether to show jobs with a status of "Completed" in the CygNet FMS Jobs control Options are as follows.
|
1 - Yes |
| ShowConfigLogRecords | Specifies whether to show configuration log records (that caused the exception) in the CygNet FMS Exceptions control Options are as follows.
|
1 - Yes |
| ShowCustomColumns | Specifies whether to show custom columns, as configured in the Admin Options (Custom Dashboard Columns page), in the CygNet FMS Dashboard control Options are as follows.
|
0 - No |
| ShowExceptionCount | Specifies whether to show the total number of exceptions for the selected Node in the CygNet FMS Dashboard control Options are as follows.
|
1 - Yes |
| ShowGasDeviceRecords | Specifies whether to show gas device records (that caused the exception) in the CygNet FMS Exceptions control Options are as follows.
|
1 - Yes |
| ShowGasStationRecords | Specifies whether to show gas station records (that caused the exception) in the CygNet FMS Exceptions control Options are as follows.
|
1 - Yes |
| ShowIgnored | Specifies whether to show ignored exceptions in the CygNet FMS Exceptions control Options are as follows.
|
1 - Yes |
| ShowLegend | Specifies whether to show the color-coded device legend at the top of the CygNet FMS Hisory Graph Options are as follows.
|
1 - Yes |
| ShowManuallyResolved | Specifies whether to show exceptions that have been resolved manually in the CygNet FMS Exceptions control Options are as follows.
|
1 - Yes |
| ShowMissingDataJobs | Specifies whether to show jobs with a status of "Missing Data" in the CygNet FMS Jobs control Options are as follows.
|
1 - Yes |
| ShowNodeDescription | Specifies whether to show the description of the selected Node in the CygNet FMS Dashboard control Options are as follows.
|
1 - Yes |
| ShowNodePriority | Specifies whether to show the Node priority of the selected Node in the CygNet FMS Dashboard control Options are as follows.
|
0 - No |
| ShowOpen | Specifies whether to show open exceptions in the CygNet FMS Exceptions control Options are as follows.
|
1 - Yes |
| ShowOpenJobs | Specifies whether to show jobs with a status of "Open" in the CygNet FMS Jobs control Options are as follows.
|
1 - Yes |
| ShowOptionsPane | Specifies whether to show the Options pane in the CygNet FMS ActiveX control Options are as follows.
|
1 - Yes |
| ShowPendingApprovalJobs | Specifies whether to show jobs with a status of "Pending Approval" in the CygNet FMS Jobs control Options are as follows.
|
1 - Yes |
| ShowPercentMissing | Specifies whether to show the percentage of missing data in the selected Node data row(s) in the CygNet FMS Dashboard control "Missing data" means records with a collection status of anything other than Good or Partial. Options are as follows.
|
1 - Yes |
| ShowReviewJobs | Specifies whether to show jobs with a status of "Review" in the CygNet FMS Jobs control Options are as follows.
|
1 - Yes |
| ShowShading | Specifies whether to show color shading in the control's cell Options are as follows.
|
3 - Both |
| ShowUnits | Specifies whether to show units in the control Options are as follows.
|
Depends on control |
| ShowUseFilterButton | Specifies whether to show the Use filter button in the Dashboard control Options are as follows.
|
1 - Yes |
| ShowVerifiedJobs | Specifies whether to show jobs with a status of "Verified" in the CygNet FMS Jobs control Options are as follows.
|
1 - Yes |
| ShowWaitingForEventsJobs | Specifies whether to show jobs with a status of "Waiting for Events" in the CygNet FMS Jobs control Options are as follows.
|
1 - Yes |
| SiteService | Specifies the value of the FMS [SiteService] | |
| UnitSet | Specifies the system unit set definition to use for the data presented in the control See Configuring Unit Set Definitions for more information. |
<Default> |
| UseFilterConfig | Specifies whether or not to use the configured filter in the FMS Alarm, Configuration, Dashboard, or Exceptions controls Options are as follows.
|
Depends on control |
| UseHeightOverride | Specifies whether to use the configured HeightOverride property for the height, in pixels, of the Value Table in the CygNet FMS History Graph control Options are as follows.
|
0 - No |
| UsePIT | Specifies whether to use the configured Point in Time for the data presented in the control Options are as follows.
|
0 - No |
| UseSessionNode | Specifies whether to use the Session Node for the data presented in the control object Options are as follows.
|
0 - No |
| UseSessionOptions | Specifies whether to use the Session options for the data presented in the control object Options are as follows.
|
0 - No |
| VisibleAttribute | Specifies the data view option selected from the context menu in the CygNet FMS Dashboard control, depending on the DataMode selected See Data view in the Using the Dashboard Control topic for more information about available data view options. |
See one of the following Properties, Methods, and Events topics for a listing of the properties, events, and methods applicable to a specific CygNet FMS ActiveX control.
|
|
|
